ssh: Add bannerfun to the server role #9149
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CT Test Results 2 files 29 suites 19m 39s ⏱️ Results for commit f60efc4. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
alexandrejbr
commented
Dec 6, 2024
alexandrejbr
force-pushed
the
alexandrejbr/ssh-bannerfun
branch
from
5f14347 to
65d5b9f
Compare
alexandrejbr
force-pushed
the
alexandrejbr/ssh-bannerfun
branch
from
65d5b9f to
c5c7b12
Compare
u3s
reviewed
Jan 7, 2025
u3s
added
testing
bannerfun/1 enables the server to send a SSH_MSG_USERAUTH_BANNER at the beginning of user authentication, immediately after receiving the first SSH_MSG_USERAUTH_BANNER
Update the existing renegotiation tests to include a bannerfun so there is a check that the erlang server sending a banner is compatible with openssh.
alexandrejbr
force-pushed
the
alexandrejbr/ssh-bannerfun
branch
from
abe8576 to
f60efc4
Compare
|
@u3s I have force pushed to fix the conflict in ssh.hrl. The branch is now rebased with the latest master. |
u3s
added
testing
u3s
reviewed
Jan 30, 2025
| @@ -213,3 +215,26 @@ retry_fun(User, Reason, #data{ssh_params = #ssh{opts = Opts, | |||
| ok | |||
| end. | |||
|
|
|||
| maybe_send_banner(D0 = #data{ssh_params = #ssh{userauth_banner_sent = false} = Ssh}, User) -> | |||
There was a problem hiding this comment.
maybe use maybe to simplify code? something like this:
maybe_send_banner(D0 = #data{ssh_params = #ssh{userauth_banner_sent = false} = Ssh}, User) ->
Opts = Ssh#ssh.opts,
BannerFun = maps:get(bannerfun, Opts, undefined),
maybe
true ?= is_function(BannerFun, 1),
BannerTxt = BannerFun(User),
true ?= is_binary(BannerTxt) andalso byte_size(BannerTxt)>0, % Ignore bad banner texts
Banner = #ssh_msg_userauth_banner{message = BannerText,
language = <<>>},
D = D0#data{ssh_params = Ssh#ssh{userauth_banner_sent = true}},
ssh_connection_handler:send_msg(Banner, D)
else
_ -> D0
end;There was a problem hiding this comment.
I can do that if you want. Other option is to have the default bannerfun being fun(V) -> <<>> end
Then the implementation can be something like this:
maybe_send_banner(D0 = #data{ssh_params = #ssh{userauth_banner_sent = false} = Ssh}, User) ->
BannerFun = ?GET_OPT(bannerfun, Ssh#ssh.opts),
case BannerFun(User) of
BannerText when is_binary(BannerText), byte_size(BannerText) > 0 ->
Banner = #ssh_msg_userauth_banner{message = BannerText,
language = <<>>},
D = D0#data{ssh_params = Ssh#ssh{userauth_banner_sent = true}},
ssh_connection_handler:send_msg(Banner, D);
_ ->
D0
end;
maybe_send_banner(D, _) ->
D.Which one do you prefer?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
bannerfun/1 enables the server to send a SSH_MSG_USERAUTH_BANNER at the beginning of user authentication, immediately after receiving the first SSH_MSG_USERAUTH_BANNER